'<INDEX> is an index to the mainPrefs.al record that has the access level settings for ShadowBot. If <INDEX> is negative, then <INDEX> is the actual access level, otherwise it points to an access level in mainPrefs.al.
'<NUMLINES> is the number of lines in the entry. When someone types !help <COMMAND>, the bot finds the offset of the first line of text and reads in <NUMLINES> of text.
'"HELP" denotes the start of an entry. Avoid starting a line with "HELP".
'Each help entry takes approximately 40 bytes of RAM. You can create your own entries or modify or delete existing ones.
'One line of white space is not necessary between each entry, but it helps for clairity when manually viewing this file.
'The first line is the argument line. This MUST NOT be counted in <NUMLINES>.
HELP OP 1 1
[nick]
Ops the nick specified. If none specified, ops you.
HELP DEOP 2 1
[nick]
Deops the nick specified. If none specified, deops you.
HELP KICK 3 1
[nick]
Kicks the nick specified. If none specified, kicks you. (Also K)
HELP K 3 1
[nick]
Kicks the nick specified. If none specified, kicks you. (Also KICK)
HELP DIE 4 2
[reason]
Makes the bot write all files, signoff, and exit. Signs off with reason specified.
If no reason, exits with the reason "!die requested"
HELP SAY 5 1
[text]
Speaks text into the channel.
HELP MSG 6 1
nick message
Sends nick a message.
HELP NOTICE 7 1
nick message
Sends nick a notice
HELP ME 8 1
action
Does an action on the current channel.
HELP TIME 9 1
[none]
Displays the time.
HELP SEEN 10 1
nick
Displays the last time nick was seen and how long ago that was.
HELP ADD 11 2
nick userAtHost accessLevel [autoOp] [prot] [pwd]
Adds the user specified to the userlist. If no params past accessLevel are displayed, then they are set to off.
If autoop is T, Y, or 1, autoop is enabled.
HELP DEL 12 1
mask
Deletes a user matching the mask given.
HELP SAVEUSERS 13 1
[none]
Saves the userlist.
HELP SAVEPREFS 14 1
[none]
Saves the main preferences files.
HELP SAVESHIT 15 1
[none]
Saves the shitlist.
HELP SAVEALL 16 1
[none]
Saves all files.
HELP USERLIST 17 1
[none]
Displays the userlist.
HELP BOTSTATS 18 1
[none]
Displays statistics about the bot. (Also STATS)
HELP STATS 18 1
[none]
Displays statistics about the bot. (Also BOTSTATS)
HELP CLVL 19 1
nick access
Changes a user in the userlist's access. You can not give someone more access than you have.
HELP CAUTO 20 1
nick autoop
Changes a user's autoop setting. If yours isn't on, you can't change theirs.
HELP ACCESS 21 1
nick
Views nick's access. If no nick is specified, your access is displayed.
HELP PING 22 1
[none]
Returns a pong response from the bot.
HELP PONG 22 1
[none]
Gag. Returns a ping respose from the bot.
HELP TOPIC 23 1
topic
Sets the topic of the channel.
HELP INFOLINE 24 1
[infoline]
Sets the text displayed when you join the channel. If you don't give an infoline, it displays yours.
HELP EMAIL 0 1
[emailAddress]
Sets your email address. If you don't give an address, it displays yours.
HELP IDLE 25 1
idleSeconds
Displays how long everyone the bot has seen is idle. If idleSeconds is present and greater than zero, displays those who have been idle longer than idleSeconds
HELP CHANGECC 26 1
newCC
Changes the bot's command character.
HELP PAGE 27 1
[none]
Pages the operator of the bot.
HELP UP 28 1
[none]
Ops you.
HELP DOWN 29 1
[none]
Deops you.
HELP BAN 30 1
nickOrMask
Bans, and then kicks, the mask of the nick passed to it, or the mask passed to it.
HELP B 30 1
nickOrMask
Same as BAN.
HELP UNBAN 31 1
nickOrMask
Unbans the nick or mask passed to it.
HELP UB 31 1
nickOrMask
Same as UNBAN.
HELP SHIT 32 3
nickOrMask shitLevel days [reason]
Shitlists the nick or mask passed to it for the number of days specified.
See !HELP SHITLEVEL for more information on the shitLevel parameter.
Reason sets the reason seen in the SHITLIST and when the user is kicked from the channel.
HELP SHITLEVEL 0 4
/not a command/
SHITLEVEL = 0: the user is effectively not shitlisted
SHITLEVEL = 1: the user is kicked on entry.
SHITLEVEL = 2: the user is bankicked, unbanned five minutes later, and rebanned if he enters the channel;
SHITLEVEL = 3: the user is kickbanned; if he is unbanned, he is rebanned.
HELP UNSHIT 33 1
nickOrMask
Removes a nick or mask from the shitlist.
HELP RSHIT 33 1
nickOrMask
Same as UNSHIT.
HELP SHITLIST 34 1
[none]
Displays the shitlist.
HELP DEAF 35 1
[none]
Executes a MODE +d (prevents the server from sending channel messages).
HELP HEAR 36 1
[none]
Executes a MODE -d (allows channel messages to be recieved).
HELP SLEEP 37 1
[none]
Causes the bot to go to sleep, ignoring all commands except AWAKE.
HELP AWAKE 38 1
[none]
Wakes the bot.
HELP COUNTRY 39 1
countryAbbrev
Displays the full country name for the abbreviation passed to it.
HELP PLUSV 40 1
nick
Executes MODE +v on a nick.
HELP V 40 1
nick
Same as PLUSV
HELP MINUSV 41 1
nick
Executes MODE -v on a nick.
HELP MV 41 1
nick
Same as MINUSV
HELP CHAT 42 1
[none]
Makes the bot DCC CHAT you.
HELP SERVER 43 1
server [port]
Changes servers.
HELP MSHITLEVEL 44 1
nick|userAtHost newShitLevel
Changes a user's shitlevel.
HELP MSHITDAYS 45 1
nick|userAtHost daysTillExpire
Changes the number of days until the shitlist entry expires.
HELP MSHITREASON 46 1
nick|userAtHost newReason
Changes the shitlist reason.
HELP CYCLE 47 1
[seconds]
Causes the bot to leave the current channel and rejoin seconds later. If seconds is zero or not present, the bot rejoins immediately.
HELP JOIN 48 1
[none]
Makes the bot join its channel.
HELP LEAVE 49 1
[none]
Makes the bot leave the channel.
HELP CPING 50 1
[nick]
Pings someone and tells you the ping time.
HELP INVITE 51 1
nick
Invites someone to the channel.
HELP SEND 52 2
nick filename
DCC SENDs a file to someone. The file must be in the DCC folder.
NOTE: When called from a script, this command does not care about access levels.
HELP IDENT 0 1
password
Allows the bot to recognize you if you have a password.
HELP PWD 0 1
oldPassword newPassword
Changes your password.
HELP HELP 0 1
command
Displays help on a command. Type !HELP TOPICS for a list of topics.
HELP ROLLCALL 0 1
[none]
Identifies the bot as a ShadowBot, displays the version, owner, and, if you have access, the bot's command character.
